<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Agile Modbus: agile_modbus_backend Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Agile Modbus
   &#160;<span id="projectnumber">1.1.4</span>
   </div>
   <div id="projectbrief">Lightweight modbus protocol stack.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structagile__modbus__backend.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">agile_modbus_backend Struct Reference<div class="ingroups"><a class="el" href="group___c_o_m_m_o_n.html">Common</a> &raquo; <a class="el" href="group___c_o_m_m_o_n___exported___types.html">Common Exported Types</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Agile Modbus backend interface structure.  
 <a href="structagile__modbus__backend.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acf381dc049072a82c7c858e042a72cae"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#acf381dc049072a82c7c858e042a72cae">backend_type</a></td></tr>
<tr class="memdesc:acf381dc049072a82c7c858e042a72cae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backend type.  <a href="structagile__modbus__backend.html#acf381dc049072a82c7c858e042a72cae">More...</a><br /></td></tr>
<tr class="separator:acf381dc049072a82c7c858e042a72cae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0af65e29883654439fa2ee3832dcd5e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#ac0af65e29883654439fa2ee3832dcd5e">header_length</a></td></tr>
<tr class="memdesc:ac0af65e29883654439fa2ee3832dcd5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header length, excluding function code.  <a href="structagile__modbus__backend.html#ac0af65e29883654439fa2ee3832dcd5e">More...</a><br /></td></tr>
<tr class="separator:ac0af65e29883654439fa2ee3832dcd5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af249a707d3885f5fbcd47b444c28a298"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#af249a707d3885f5fbcd47b444c28a298">checksum_length</a></td></tr>
<tr class="memdesc:af249a707d3885f5fbcd47b444c28a298"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check data length.  <a href="structagile__modbus__backend.html#af249a707d3885f5fbcd47b444c28a298">More...</a><br /></td></tr>
<tr class="separator:af249a707d3885f5fbcd47b444c28a298"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a992fc2f989ae287cc1dd24ab18de88f3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#a992fc2f989ae287cc1dd24ab18de88f3">max_adu_length</a></td></tr>
<tr class="memdesc:a992fc2f989ae287cc1dd24ab18de88f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backend ADU length.  <a href="structagile__modbus__backend.html#a992fc2f989ae287cc1dd24ab18de88f3">More...</a><br /></td></tr>
<tr class="separator:a992fc2f989ae287cc1dd24ab18de88f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3409b195ea47bd306bcf502dd022a9"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#a8d3409b195ea47bd306bcf502dd022a9">set_slave</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int slave)</td></tr>
<tr class="memdesc:a8d3409b195ea47bd306bcf502dd022a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set address interface.  <a href="structagile__modbus__backend.html#a8d3409b195ea47bd306bcf502dd022a9">More...</a><br /></td></tr>
<tr class="separator:a8d3409b195ea47bd306bcf502dd022a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1c930c538d90281d83ed4c9cc18f1ac"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#af1c930c538d90281d83ed4c9cc18f1ac">build_request_basis</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int function, int addr, int nb, uint8_t *req)</td></tr>
<tr class="memdesc:af1c930c538d90281d83ed4c9cc18f1ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a basic request message interface.  <a href="structagile__modbus__backend.html#af1c930c538d90281d83ed4c9cc18f1ac">More...</a><br /></td></tr>
<tr class="separator:af1c930c538d90281d83ed4c9cc18f1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf149ef36ca2b44e5b1b45e061f2860"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#a9cf149ef36ca2b44e5b1b45e061f2860">build_response_basis</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaa551bce4815f2889224102ac08f779ad">agile_modbus_sft_t</a> *sft, uint8_t *rsp)</td></tr>
<tr class="memdesc:a9cf149ef36ca2b44e5b1b45e061f2860"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a basic response message interface.  <a href="structagile__modbus__backend.html#a9cf149ef36ca2b44e5b1b45e061f2860">More...</a><br /></td></tr>
<tr class="separator:a9cf149ef36ca2b44e5b1b45e061f2860"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae604a6f4cd8f8102f737671b1911320a"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#ae604a6f4cd8f8102f737671b1911320a">prepare_response_tid</a> )(const uint8_t *req, int *req_length)</td></tr>
<tr class="memdesc:ae604a6f4cd8f8102f737671b1911320a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare response interface.  <a href="structagile__modbus__backend.html#ae604a6f4cd8f8102f737671b1911320a">More...</a><br /></td></tr>
<tr class="separator:ae604a6f4cd8f8102f737671b1911320a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae22c3d64197febe904d592895705d07b"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#ae22c3d64197febe904d592895705d07b">send_msg_pre</a> )(uint8_t *req, int req_length)</td></tr>
<tr class="memdesc:ae22c3d64197febe904d592895705d07b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pre-send data interface.  <a href="structagile__modbus__backend.html#ae22c3d64197febe904d592895705d07b">More...</a><br /></td></tr>
<tr class="separator:ae22c3d64197febe904d592895705d07b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b5d593afcd73504dd8b0977173dcb16"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#a5b5d593afcd73504dd8b0977173dcb16">check_integrity</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, uint8_t *msg, const int msg_length)</td></tr>
<tr class="memdesc:a5b5d593afcd73504dd8b0977173dcb16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the receive data integrity interface.  <a href="structagile__modbus__backend.html#a5b5d593afcd73504dd8b0977173dcb16">More...</a><br /></td></tr>
<tr class="separator:a5b5d593afcd73504dd8b0977173dcb16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b202def5092468ba9f8ea59f81b2bc3"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus__backend.html#a9b202def5092468ba9f8ea59f81b2bc3">pre_check_confirmation</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, const uint8_t *req, const uint8_t *rsp, int rsp_length)</td></tr>
<tr class="memdesc:a9b202def5092468ba9f8ea59f81b2bc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pre-check confirmation interface.  <a href="structagile__modbus__backend.html#a9b202def5092468ba9f8ea59f81b2bc3">More...</a><br /></td></tr>
<tr class="separator:a9b202def5092468ba9f8ea59f81b2bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Agile Modbus backend interface structure. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00198">198</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="acf381dc049072a82c7c858e042a72cae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf381dc049072a82c7c858e042a72cae">&#9670;&nbsp;</a></span>backend_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t agile_modbus_backend::backend_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Backend type. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00199">199</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="ac0af65e29883654439fa2ee3832dcd5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0af65e29883654439fa2ee3832dcd5e">&#9670;&nbsp;</a></span>header_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t agile_modbus_backend::header_length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Header length, excluding function code. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00200">200</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="af249a707d3885f5fbcd47b444c28a298"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af249a707d3885f5fbcd47b444c28a298">&#9670;&nbsp;</a></span>checksum_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t agile_modbus_backend::checksum_length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check data length. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00201">201</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a992fc2f989ae287cc1dd24ab18de88f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a992fc2f989ae287cc1dd24ab18de88f3">&#9670;&nbsp;</a></span>max_adu_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t agile_modbus_backend::max_adu_length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Backend ADU length. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00202">202</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a8d3409b195ea47bd306bcf502dd022a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3409b195ea47bd306bcf502dd022a9">&#9670;&nbsp;</a></span>set_slave</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::set_slave) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int slave)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set address interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00203">203</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="af1c930c538d90281d83ed4c9cc18f1ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1c930c538d90281d83ed4c9cc18f1ac">&#9670;&nbsp;</a></span>build_request_basis</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::build_request_basis) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int function, int addr, int nb, uint8_t *req)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Build a basic request message interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00204">204</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a9cf149ef36ca2b44e5b1b45e061f2860"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf149ef36ca2b44e5b1b45e061f2860">&#9670;&nbsp;</a></span>build_response_basis</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::build_response_basis) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaa551bce4815f2889224102ac08f779ad">agile_modbus_sft_t</a> *sft, uint8_t *rsp)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Build a basic response message interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00206">206</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="ae604a6f4cd8f8102f737671b1911320a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae604a6f4cd8f8102f737671b1911320a">&#9670;&nbsp;</a></span>prepare_response_tid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::prepare_response_tid) (const uint8_t *req, int *req_length)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prepare response interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00207">207</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="ae22c3d64197febe904d592895705d07b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae22c3d64197febe904d592895705d07b">&#9670;&nbsp;</a></span>send_msg_pre</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::send_msg_pre) (uint8_t *req, int req_length)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pre-send data interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00208">208</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a5b5d593afcd73504dd8b0977173dcb16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b5d593afcd73504dd8b0977173dcb16">&#9670;&nbsp;</a></span>check_integrity</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::check_integrity) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, uint8_t *msg, const int msg_length)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check the receive data integrity interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00209">209</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a9b202def5092468ba9f8ea59f81b2bc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b202def5092468ba9f8ea59f81b2bc3">&#9670;&nbsp;</a></span>pre_check_confirmation</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus_backend::pre_check_confirmation) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, const uint8_t *req, const uint8_t *rsp, int rsp_length)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pre-check confirmation interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00210">210</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/runner/work/agile_modbus/agile_modbus/inc/<a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structagile__modbus__backend.html">agile_modbus_backend</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
